From c4a13b5287144b43963217fc0528a6a14527b3d8 Mon Sep 17 00:00:00 2001 From: Cosimo Cecchi Date: Thu, 12 Jan 2012 14:02:29 -0500 Subject: [PATCH] window: improve docs for gtk_window_set_attached_to() --- gtk/gtkwindow.c | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index 452d3e1630..8f6746a7c7 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -2617,13 +2617,18 @@ gtk_window_get_transient_for (GtkWindow *window) * @window: a #GtkWindow * @attach_widget (allow-none): a #GtkWidget, or %NULL * - * Attach the window to a widget. Indicates that @window belongs to @widget. - * For example the window of a GtkMenu could belong to a GtkMenuBar or - * a GtkEntry or a GtkComboBox, and so on... - * - * GTK will use this information for styling the @window, - * for presenting it as a child of @widget in the accessibility tree - * and other things. + * Marks @window as attached to @attach_widget. This creates a logical binding + * between the window and the widget it belongs to, which is used by GTK to + * propagate information such as styling or accessibility to @window as if it + * was a children of @attach_widget. + * + * Examples of places where specifying this relation is useful are for instance + * a #GtkMenu created by a #GtkComboBox, a completion popup window + * created by #GtkEntry or a typeahead search entry created by #GtkTreeView. + * + * Note that this function should not be confused with + * #gtk_window_set_transient_for, which specifies a window manager relation + * between two toplevels instead. * * Passing %NULL for @attach_widget detaches the window. * -- 2.30.2